home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / amspel20.zip / AMSPELL.DOC (.txt) < prev    next >
LaTeX Document  |  1992-08-01  |  20KB  |  349 lines
  1. =================
  2.      amSpell
  3. =================
  4. A spell checker for ASCII and (La)TeX files
  5. ===========================================
  6. Concepts
  7. --------
  8. amSpell is basically a spell checker for plain ASCII files, with some 
  9. special features for dealing with TeX files. The program is written in 
  10. Turbo Pascal and runs on any MS-DOS computer.
  11. The basic idea behind this program is to make spell checking easier by
  12. *  providing the context of the possibly misspelled word;
  13. *  offering alternatives;
  14. *  offering facilities for editing the word;
  15. *  automatically replacing wrong words by the indicated words;
  16. *  learning new words.
  17. amSpell and (La)TeX
  18. -------------------
  19. amSpell does not require TeX commands to be removed. In fact, it will even 
  20. interpret the standard accenting commands like \", \`, \' and will
  21. automatically use them while replacing wrongly spelled words. When checking 
  22. a TeX file amSpell will ignore all text between $'s and $$'s. Furthermore, 
  23. amSpell will ignore the parameter of the LaTeX commands \ref, \pageref, 
  24. \cite, \nocite, label, and all text between \begin{equation}, 
  25. \begin{eqnarray}, \[ and their counterparts such as \]. All words starting 
  26. with a backslash are ignored.
  27. Naturally amSpell will conform to the capitalization in each word.
  28. amSpell is DesqView aware. If DesqView is active, then for simple screen 
  29. writes, it uses the BIOS and for intensive screen writes, it uses the 
  30. Virtual Screen Buffer of DV.
  31. Dictionaries
  32. ------------
  33. It is convenient to make amSpell use three types of input files:
  34. *  A file containing all jargon and correct words not included in the
  35.    dictionary files;
  36. *  The dictionary files: usually about 26 files, each containing all words
  37.    with the same initial, e.g., US.00A, US.00B etc.;
  38. *  Plus of course the file that needs to be checked.
  39. Files of the first and third type should be kept sorted alphabetically, 
  40. i.e., according to the ASCII table. This means that, e.g., french words 
  41. starting with 
  42.  should not be appended to FR.00E, but should be separated 
  43. in a file called FR.00
  44. These files should be plain text files containing just one word per line.
  45. A compression program is provided (SPCOMP.EXE) as well as a decompression 
  46. program (SPDECOMP.EXE). Compression speeds up the reading of a file and 
  47. saves disk space.
  48. The dictionary files are split into about 26 sections, according to the 
  49. initial of a word. There are two reasons for this approach:
  50. 1.  Separate files are relatively easy to edit.
  51. 2.  This sectioning enables amSpell to find alternatives for words that are 
  52.     not in the dictionaries. amSpell will look for words with the same 
  53.     initial that somehow `look' like it, in order to correct common typing 
  54.     errors. E.g., if you typed `egnlisch' amSpell will suggest `english' as 
  55.     correction, but it will not find the correct spelling of `Ugoslavia'.
  56. Parameters
  57. ----------
  58. If you start amSpell without any parameters it will show the screen below:
  59. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  60. amSpell 2.03 - Ascii/TeX SpellingChecker - Copyright (c) A. Merckens  92-08-01
  61. All words in the input file will be checked using one or more dictionaries.
  62. SPELL -? for more help.                                    ^Break to ABORT.
  63. Input file                   Inputfil
  64. Output file                  wrong.spl
  65. Batch of Dictionaries (Y/N)  N
  66. Dictionary                   NONE
  67. Auxiliary dictionary         NONE
  68. Occurrences (Y/N)            N          Capitalization (Y/N)         N
  69. Multiple occurrences (Y/N)   N          TeX text (Y/N)               N
  70. Linenumbers (Y/N)            N          Unsorted dictionaries (Y/N)  N
  71. Suggestions (Y/N)            N          Edit misspelled words (Y/N)  N
  72. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  73. You can interactively enter your file names and parameters.
  74. If you want to know more about the parameters you may enter AMSPELL -? in 
  75. which case amSpell will show the screen below:
  76. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  77. amSpell 2.03 - Ascii/TeX SpellingChecker - Copyright (c) A. Merckens  92-08-01
  78.                                                                                 
  79. Call: AMSPELL <options> <inputfile> <outputfile> <dict1> <dict2> <@optionfile>
  80. Options are:                                                                    
  81.   /b   - up to 100 dictionaries are named in a "Batch" file                     
  82.   /c   - write words with Capitalization based on first occurrence              
  83.   /d   - Directvideo off - use BIOS to write to screen                          
  84.   /e   - Edit the misspelled words; this option puts /m on, /l and /o off       
  85.          Words can be 'learned', i.e. appended to the file LEARNSPL.SPL         
  86.          When editing, F1 gives help on the function of special keys            
  87.   /h   - this Help                                                              
  88.   /i   - Ignore missing directories                                             
  89.   /k   - sKip spellingscheck - all words are misspelled                         
  90.   /l   - write Linenumbers along with the words                                 
  91.   /m   - remember Multiple occurrences with different capitalization
  92.   /n   - Not so many screen updates (somewhat faster)                           
  93.   /o   - write number of Occurrences of the words                               
  94.   /q   - be Quiet: do not ask for confirmation of the command-line              
  95.   /s[i]- search for similar words: give up to i*5 Suggestions, i=1..9           
  96.   /t   - TeX text: do not check formulae, labels, references, cites             
  97.   /u   - the dictionaries are Unsorted                                          
  98.   /v   - Verify off: delete existing output file                                
  99.   /z   - Zero screen writes                                                     
  100.   /_   - ignore words containing an _                                           
  101.   /0   - ignore words containing digits 0-9
  102.   /1   - <inputfile> is not a file but a word to be checked                     
  103.   /-   - the symbol - is NOT a word separator                                   
  104.   /'   - the symbol ' IS a word separator
  105. The options may be specified in the so called optionfile
  106.                                                                                 
  107. The dictionary files are assumed to have one "word" per line,                   
  108. or have the special SPL format.                                                 
  109.                                                                                 
  110. The special name "NONE" means: no dictionary                                    
  111.                                                                                 
  112. If /b is specified, then <dict1> is a "batch" file that contains                
  113. all filenames of the dictionaries to be used.                                   
  114.                                                                                 
  115. Copyright (C) 1992 A. Merckens - Internet: ambase@rugr86.rug.nl
  116. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  117. Here is a more detailed description of all parameters:
  118. /b    up to 100 dictionaries are named in a "batch" file.
  119.       A batch file will typically look like this:
  120.          correct.us
  121.          c:\tex\spell\us.00a
  122.          c:\tex\spell\us.00b
  123.          ...
  124.          c:\tex\spell\us.00z
  125.       The first line specifies the name of the file that contains correctly 
  126.       spelled words that are not in the dictionaries (usually jargon, 
  127.       author names etc.). The next 26 or so specify the dictionaries from a 
  128.       through z.
  129.       You may use environment parameters in this file. Example:
  130.          correct.%LANG%
  131.          %DRIVE%%SPELLDIR\us.00a
  132.          %SPELLDIR\us.00b
  133.          ...
  134.          %SPELLDIR%\us.00z
  135.       Now you can dynamically set %LANG%, %DRIVE% and %SPELLDIR% before you 
  136.       start amSpell.
  137. /c    write words with Capitalization based on first occurrence.
  138. /d    Directvideo off -- use BIOS to write to screen. Use this switch if 
  139.       your screen gets messy or shows `snow' running amSpell. This might be 
  140.